<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libcoap: coap_optlist_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">libcoap<span id="projectnumber">&#160;4.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structcoap__optlist__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">coap_optlist_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Representation of chained list of CoAP options to install.  
 <a href="structcoap__optlist__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="option_8h_source.html">option.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a96f83935e6d948a1993eee7e5f2fb529" id="r_a96f83935e6d948a1993eee7e5f2fb529"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">struct</a> <a class="el" href="structcoap__optlist__t.html">coap_optlist_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__optlist__t.html#a96f83935e6d948a1993eee7e5f2fb529">next</a></td></tr>
<tr class="memdesc:a96f83935e6d948a1993eee7e5f2fb529"><td class="mdescLeft">&#160;</td><td class="mdescRight">next entry in the optlist chain  <br /></td></tr>
<tr class="separator:a96f83935e6d948a1993eee7e5f2fb529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e0e2a73913a4888f690c6fa43815698" id="r_a1e0e2a73913a4888f690c6fa43815698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__optlist__t.html#a1e0e2a73913a4888f690c6fa43815698">number</a></td></tr>
<tr class="memdesc:a1e0e2a73913a4888f690c6fa43815698"><td class="mdescLeft">&#160;</td><td class="mdescRight">the option number (no delta coding)  <br /></td></tr>
<tr class="separator:a1e0e2a73913a4888f690c6fa43815698"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24a8480763cc064bdd31ab4252dce9e2" id="r_a24a8480763cc064bdd31ab4252dce9e2"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">length</a></td></tr>
<tr class="memdesc:a24a8480763cc064bdd31ab4252dce9e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">the option value length  <br /></td></tr>
<tr class="separator:a24a8480763cc064bdd31ab4252dce9e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47aa4fd0063b0d91f2b1892cfe0b6175" id="r_a47aa4fd0063b0d91f2b1892cfe0b6175"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcoap__optlist__t.html#a47aa4fd0063b0d91f2b1892cfe0b6175">data</a></td></tr>
<tr class="memdesc:a47aa4fd0063b0d91f2b1892cfe0b6175"><td class="mdescLeft">&#160;</td><td class="mdescRight">the option data  <br /></td></tr>
<tr class="separator:a47aa4fd0063b0d91f2b1892cfe0b6175"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Representation of chained list of CoAP options to install. </p>
<div class="fragment"><div class="line"><a class="code hl_struct" href="structcoap__optlist__t.html">coap_optlist_t</a> *<a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">optlist_chain</a> = <a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">NULL</a>;</div>
<div class="line"><a class="code hl_struct" href="structcoap__pdu__t.html">coap_pdu_t</a> *pdu = <a class="code hl_function" href="pdu_8c.html#ade1a728d3049d57703d805e71d0a38dd">coap_new_pdu</a>(session);</div>
<div class="line"> </div>
<div class="line">... <a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">other</a> <a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">set</a> <a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">up</a> code ...</div>
<div class="line">coap_insert_optlist(&amp;<a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">optlist_chain</a>, <a class="code hl_function" href="option_8h.html#a21df6c3988187909d52a3218eb2f12ef">coap_new_optlist</a>(<a class="code hl_define" href="pdu_8h.html#adf17a37fe3a833c8120d5414313c8655">COAP_OPTION_OBSERVE</a>,</div>
<div class="line">                   <a class="code hl_define" href="group__observe.html#ga8f172a982abdbb1c45fc5bdb90a23da4">COAP_OBSERVE_ESTABLISH</a>, <a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">NULL</a>));</div>
<div class="line"> </div>
<div class="line"><a class="code hl_function" href="option_8h.html#aac21dee6a4689d2000017e4b95564a2a">coap_add_optlist_pdu</a>(pdu, &amp;<a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">optlist_chain</a>);</div>
<div class="line">... <a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">other</a> code ...</div>
<div class="line">coap_delete_optlist(<a class="code hl_variable" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">optlist_chain</a>);</div>
<div class="ttc" id="agroup__observe_html_ga8f172a982abdbb1c45fc5bdb90a23da4"><div class="ttname"><a href="group__observe.html#ga8f172a982abdbb1c45fc5bdb90a23da4">COAP_OBSERVE_ESTABLISH</a></div><div class="ttdeci">#define COAP_OBSERVE_ESTABLISH</div><div class="ttdoc">The value COAP_OBSERVE_ESTABLISH in a GET request indicates a new observe relationship for (sender ad...</div><div class="ttdef"><b>Definition</b> <a href="subscribe_8h_source.html#l00029">subscribe.h:29</a></div></div>
<div class="ttc" id="aoption_8h_html_a21df6c3988187909d52a3218eb2f12ef"><div class="ttname"><a href="option_8h.html#a21df6c3988187909d52a3218eb2f12ef">coap_new_optlist</a></div><div class="ttdeci">coap_optlist_t * coap_new_optlist(uint16_t number, size_t length, const uint8_t *data)</div><div class="ttdoc">Create a new optlist entry.</div><div class="ttdef"><b>Definition</b> <a href="option_8c_source.html#l00551">option.c:551</a></div></div>
<div class="ttc" id="aoption_8h_html_aac21dee6a4689d2000017e4b95564a2a"><div class="ttname"><a href="option_8h.html#aac21dee6a4689d2000017e4b95564a2a">coap_add_optlist_pdu</a></div><div class="ttdeci">int coap_add_optlist_pdu(coap_pdu_t *pdu, coap_optlist_t **optlist_chain)</div><div class="ttdoc">The current optlist of optlist_chain is first sorted (as per RFC7272 ordering requirements) and then ...</div><div class="ttdef"><b>Definition</b> <a href="option_8c_source.html#l00584">option.c:584</a></div></div>
<div class="ttc" id="apdu_8c_html_ade1a728d3049d57703d805e71d0a38dd"><div class="ttname"><a href="pdu_8c.html#ade1a728d3049d57703d805e71d0a38dd">coap_new_pdu</a></div><div class="ttdeci">coap_pdu_t * coap_new_pdu(const struct coap_session_t *session)</div><div class="ttdoc">Creates a new CoAP PDU.</div><div class="ttdef"><b>Definition</b> <a href="pdu_8c_source.html#l00131">pdu.c:131</a></div></div>
<div class="ttc" id="apdu_8h_html_adf17a37fe3a833c8120d5414313c8655"><div class="ttname"><a href="pdu_8h.html#adf17a37fe3a833c8120d5414313c8655">COAP_OPTION_OBSERVE</a></div><div class="ttdeci">#define COAP_OPTION_OBSERVE</div><div class="ttdef"><b>Definition</b> <a href="pdu_8h_source.html#l00112">pdu.h:112</a></div></div>
<div class="ttc" id="astructcoap__optlist__t_html"><div class="ttname"><a href="structcoap__optlist__t.html">coap_optlist_t</a></div><div class="ttdoc">Representation of chained list of CoAP options to install.</div><div class="ttdef"><b>Definition</b> <a href="option_8h_source.html#l00408">option.h:408</a></div></div>
<div class="ttc" id="astructcoap__optlist__t_html_a24a8480763cc064bdd31ab4252dce9e2"><div class="ttname"><a href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">coap_optlist_t::length</a></div><div class="ttdeci">size_t length</div><div class="ttdoc">the option value length</div><div class="ttdef"><b>Definition</b> <a href="option_8h_source.html#l00411">option.h:411</a></div></div>
<div class="ttc" id="astructcoap__pdu__t_html"><div class="ttname"><a href="structcoap__pdu__t.html">coap_pdu_t</a></div><div class="ttdoc">structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...</div><div class="ttdef"><b>Definition</b> <a href="pdu_8h_source.html#l00285">pdu.h:285</a></div></div>
</div><!-- fragment --> 
<p class="definition">Definition at line <a class="el" href="option_8h_source.html#l00408">408</a> of file <a class="el" href="option_8h_source.html">option.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a47aa4fd0063b0d91f2b1892cfe0b6175" name="a47aa4fd0063b0d91f2b1892cfe0b6175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47aa4fd0063b0d91f2b1892cfe0b6175">&#9670;&#160;</a></span>data</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>* coap_optlist_t::data</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the option data </p>

<p class="definition">Definition at line <a class="el" href="option_8h_source.html#l00412">412</a> of file <a class="el" href="option_8h_source.html">option.h</a>.</p>

</div>
</div>
<a id="a24a8480763cc064bdd31ab4252dce9e2" name="a24a8480763cc064bdd31ab4252dce9e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24a8480763cc064bdd31ab4252dce9e2">&#9670;&#160;</a></span>length</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t coap_optlist_t::length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the option value length </p>

<p class="definition">Definition at line <a class="el" href="option_8h_source.html#l00411">411</a> of file <a class="el" href="option_8h_source.html">option.h</a>.</p>

</div>
</div>
<a id="a96f83935e6d948a1993eee7e5f2fb529" name="a96f83935e6d948a1993eee7e5f2fb529"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96f83935e6d948a1993eee7e5f2fb529">&#9670;&#160;</a></span>next</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">struct</a> <a class="el" href="structcoap__optlist__t.html">coap_optlist_t</a>* coap_optlist_t::next</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>next entry in the optlist chain </p>

<p class="definition">Definition at line <a class="el" href="option_8h_source.html#l00409">409</a> of file <a class="el" href="option_8h_source.html">option.h</a>.</p>

</div>
</div>
<a id="a1e0e2a73913a4888f690c6fa43815698" name="a1e0e2a73913a4888f690c6fa43815698"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e0e2a73913a4888f690c6fa43815698">&#9670;&#160;</a></span>number</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcoap__optlist__t.html#a24a8480763cc064bdd31ab4252dce9e2">uint16_t</a> coap_optlist_t::number</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the option number (no delta coding) </p>

<p class="definition">Definition at line <a class="el" href="option_8h_source.html#l00410">410</a> of file <a class="el" href="option_8h_source.html">option.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="option_8h_source.html">option.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structcoap__optlist__t.html">coap_optlist_t</a></li>
    <li class="footer">Generated on Fri Dec 27 2024 09:57:44 for libcoap by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
  </ul>
</div>
</body>
</html>
